org.eclipse.vtp.framework.interactions.voice.vxml
Class Rule

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.Rule

All Implemented Interfaces:

VXMLConstants

public class Rule
extends Widget
implements VXMLConstants

A rule declaration for inline grammars.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

Rule(java.lang.String id)
Creates a new Rule.

Method Summary

void	addItem(Iota item) Adds an item to this rule's list.
java.lang.String	getId() Returns the ID of this rule.
Item[]	getItems() Returns the list of items in this rule.
void	removeItem(Iota item) Removes an item from this rule's list.
void	setId(java.lang.String id) Sets the ID of this rule.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this set to the supplied set.
protected void	writeItems(org.xml.sax.ContentHandler outputHandler) Write the content of this set to the specified content handler.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Rule

public Rule(java.lang.String id)
     throws java.lang.IllegalArgumentException,
            java.lang.NullPointerException

Creates a new Rule.

Parameters:

id - The ID of this rule.

Throws:

java.lang.IllegalArgumentException - If the specified ID is empty.

java.lang.NullPointerException - If the specified ID is null.

Method Detail

getId

public java.lang.String getId()

Returns the ID of this rule.

Returns:

id The ID of this rule.

getItems

public Item[] getItems()

Returns the list of items in this rule.

Returns:

The list of items in this rule.

setId

public void setId(java.lang.String id)
           throws java.lang.IllegalArgumentException,
                  java.lang.NullPointerException

Sets the ID of this rule.

Parameters:

id - The ID of this rule.

Throws:

java.lang.IllegalArgumentException - If the specified ID is empty.

java.lang.NullPointerException - If the specified ID is null.

addItem

public void addItem(Iota item)
             throws java.lang.NullPointerException

Adds an item to this rule's list.

Parameters:

item - The item to add.

Throws:

java.lang.NullPointerException - If the specified item is null.

removeItem

public void removeItem(Iota item)
                throws java.lang.NullPointerException

Removes an item from this rule's list.

Parameters:

item - The item to remove.

Throws:

java.lang.NullPointerException - If the specified item is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Write the attribute members of this set to the supplied set.

Parameters:

attributes - The attribute set to write to.

Throws:

java.lang.NullPointerException - If the supplied attribute set is null.

writeItems

protected void writeItems(org.xml.sax.ContentHandler outputHandler)
                   throws java.lang.NullPointerException,
                          org.xml.sax.SAXException

Write the content of this set to the specified content handler.

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of any of the items fails.